// Copyright 2025 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once

#include "pw_result/result.h"
#include "pw_tokenizer/detokenize.h"

namespace pw::tokenizer {

/// @submodule{pw_tokenizer,detokenize}

/// Constructs a detokenizer from the `.pw_tokenizer.entries` section of this
/// executable program.
///
/// NOTE: This requires linking with
/// `add_detokenize_from_this_program_sections.ld` or equivalent.
/// For Bazel builds this is handled automatically.
/// For other builds, see the corresponding build file.
Result<Detokenizer> GetDetokenizerFromThisProgram();

/// @}

}  // namespace pw::tokenizer
